Terraform Registry に CDK for Terraform のドキュメントが追加されました!

Terraform Registry に CDK for Terraform のドキュメントが追加されました!

Terraform でリソース作る際にいつも見るドキュメントに、 CDK for Terraform のドキュメントが一部追加されました!
Clock Icon2023.07.25

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

こんにちは! AWS 事業本部コンサルティング部のたかくに(@takakuni_)です。

みなさん、 CDK for Terraform 使っていますでしょうか? 私は最近使い始めました。

ついに、 Terraform Registry が Multi-language provider docs に対応しました。このアップデートにより、 Terraform Registry(Terraform でリソース作る時にいつもみるドキュメント)に CDK for Terraform だったらどう書くのかが追加されました!

まとめ

忙しい人向けの先にまとめです。

  • CDK の世界でいう L1 コンストラクトのドキュメントが追加
  • 現在は TypeScript, Python の 2 言語のみサポート
  • 現段階では一部リソースのみサポートされている
    • AWS Provider の中の EC2, Lambda, VPC, and EKS
    • Terraform Cloud/Enterprise プロバイダ
AWS Provider でサポートされているリソース一覧(2023/6/25 現在)

Resource ブロック

Data ブロック

GitHub から追いました!

何が良くなったのか

これまで、 L1 コンストラクタで作成する際にプロパティをどうやって確認していたかというと、 Construct Hub や、lib の index.d.ts を見たり、慣れてくると HCL のキャメルケースバージョンだな..? と予測して、プロパティを設定していく流れでした。 余談ですが私は最近、 Amazon CodeWhisperer に大変お世話になっています。

今回のアップデートで、 Terraform Registry に CDK for Terraform のドキュメントが反映され、一元化できるようになってきました!(ここ大事)

見てみる

以下は実際のドキュメントを眺めてみた結果です。新しく「Multi-language provider docs」と記載があり、Terraform (HCL) の他に、TypeScript, Python が選択できるようになっています。

言語を選択すると、 Example Usage として幾つかサンプルコードと、定義するプロパティの説明が記載されています。

対応していないドキュメント

対応していないドキュメントみると、「This page is not yet translated to TypeScript. The Terraform (HCL) version is shown instead.」と記載がありました。

気長に待つか、 hashicorp/terraform-provider-aws に Pull Request してみるのもいいかもしれません。

まとめ

AWS CDK と比べ、まだまだ発展途中ではありますが、一歩ずつ着実に進化を遂げている CDK for Terraform です。今後のさらなる展望に期待しながら、ガンガン触っていきたいと思います。

以上、AWS 事業本部コンサルティング部のたかくに(@takakuni_)でした!

参考

Share this article

facebook logohatena logotwitter logo

© Classmethod, Inc. All rights reserved.